home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / ap_listen.h.z / ap_listen.h
C/C++ Source or Header  |  2002-07-08  |  6KB  |  153 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  */
  54.  
  55. #ifndef AP_LISTEN_H
  56. #define AP_LISTEN_H
  57.  
  58. #include "apr_network_io.h"
  59. #include "httpd.h"
  60. #include "http_config.h"
  61.  
  62. /**
  63.  * @package Apache Listeners Library
  64.  */
  65.  
  66. typedef struct ap_listen_rec ap_listen_rec;
  67. typedef apr_status_t (*accept_function)(void **csd, ap_listen_rec *lr, apr_pool_t *ptrans);
  68.  
  69. /**
  70.  * Apache's listeners record.  These are used in the Multi-Processing Modules
  71.  * to setup all of the sockets for the MPM to listen to and accept on.
  72.  */
  73. struct ap_listen_rec {
  74.     /**
  75.      * The next listener in the list
  76.      */
  77.     ap_listen_rec *next;
  78.     /**
  79.      * The actual socket 
  80.      */
  81.     apr_socket_t *sd;
  82.     /**
  83.      * The sockaddr the socket should bind to
  84.      */
  85.     apr_sockaddr_t *bind_addr;
  86.     /**
  87.      * The accept function for this socket
  88.      */
  89.     accept_function accept_func;
  90.     /**
  91.      * Is this socket currently active 
  92.      */
  93.     int active;
  94. /* more stuff here, like which protocol is bound to the port */
  95. };
  96.  
  97. /**
  98.  * The global list of ap_listen_rec structures
  99.  */
  100. AP_DECLARE_DATA extern ap_listen_rec *ap_listeners;
  101.  
  102. /**
  103.  * Setup all of the defaults for the listener list
  104.  */
  105. void ap_listen_pre_config(void);
  106. #if !defined(SPMT_OS2_MPM)
  107. /**
  108.  * Loop through the global ap_listen_rec list and create all of the required
  109.  * sockets.  This executes the listen and bind on the sockets.
  110.  * @param s The global server_rec
  111.  * @return The number of open sockets.
  112.  * @warning This function is not available to Windows platforms, or the
  113.  * Prefork or SPMT_OS2 MPMs.
  114.  */ 
  115. int ap_setup_listeners(server_rec *s);
  116. #endif
  117. /* Split into two #if's to make the exports scripts easier.
  118.  */
  119. #if defined(SPMT_OS2_MPM)
  120. /**
  121.  * Create and open a socket on the specified port.  This includes listening
  122.  * and binding the socket.
  123.  * @param process The process record for the currently running server
  124.  * @param port The port to open a socket on.
  125.  * @return The number of open sockets
  126.  * @warning This function is only available to Windows platforms, or the
  127.  * Prefork or SPMT_OS2 MPMs.
  128.  */
  129. int ap_listen_open(process_rec *process, apr_port_t port);
  130. #endif
  131.  
  132. /* Although these functions are exported from libmain, they are not really
  133.  * public functions.  These functions are actually called while parsing the
  134.  * config file, when one of the LISTEN_COMMANDS directives is read.  These
  135.  * should not ever be called by external modules.  ALL MPMs should include
  136.  * LISTEN_COMMANDS in their command_rec table so that these functions are
  137.  * called.
  138.  */ 
  139. const char *ap_set_listenbacklog(cmd_parms *cmd, void *dummy, const char *arg);
  140. const char *ap_set_listener(cmd_parms *cmd, void *dummy, const char *ips);
  141. const char *ap_set_send_buffer_size(cmd_parms *cmd, void *dummy,
  142.                     const char *arg);
  143.  
  144. #define LISTEN_COMMANDS    \
  145. AP_INIT_TAKE1("ListenBacklog", ap_set_listenbacklog, NULL, RSRC_CONF, \
  146.   "Maximum length of the queue of pending connections, as used by listen(2)"), \
  147. AP_INIT_TAKE1("Listen", ap_set_listener, NULL, RSRC_CONF, \
  148.   "A port number or a numeric IP address and a port number"), \
  149. AP_INIT_TAKE1("SendBufferSize", ap_set_send_buffer_size, NULL, RSRC_CONF, \
  150.   "Send buffer size in bytes")
  151.  
  152. #endif
  153.